Improve Ref Docs#5

Merged

kattni merged 12 commits intoadafruit:masterfrom

sommersoft:new_docs

Feb 28, 2018

Collaborator

sommersoft commented Feb 26, 2018

sommersoft added 11 commits

February 25, 2018 21:57


          setup docs folder; removed old api index file

ce15cbd


          updated .travis & .readthedocs.yml

c180407


          updated README

31626e9


          updated Related Products; no Trellis here

502d8de


          updated docsstrings; removed 'get/set' statements

5e21438


          my Travis is borked; stab-in-the-dark pylint/sphinx fixes

3a2fd4b


          sphinx conf.py had an extra autodoc_mock_import setting that cleared …

6d5f3e4

…out the import mocks


          fixed typo

b030432


          updated README; moved Trellis note from index.rst

ab21648


          cleaned up Related Products entry

3562a30


          update README; re-formatting

436522a

kattni suggested changes

View reviewed changes

Contributor

kattni left a comment

Thanks for doing this! Let me know what the white space issue specifically is so we can discuss it.

adafruit_ht16k33/segments.py Outdated


		from adafruit_ht16k33.ht16k33 import HT16K33

		# pylint disable=bad-whitespace

Contributor

kattni Feb 27, 2018

I believe the white space issue here is that there should be two spaces before the #. If this is the case, I would rather we add the extra space than disable pylint. If that's not the issue, let me know and we can discuss the options.

Collaborator Author

sommersoft Feb 28, 2018

Actually, it was a guess. Per the "my Travis is borked" commit, Travis was taking time in resyncing the deleted->re-forked repo. It showed me the overall status, but wouldn't load the log so I didn't know what was failing. I can easily remove the disable and see if it passes.


          removed pylint bad-whitespace

9d07c1e

Collaborator Author

sommersoft commented Feb 28, 2018

@kattni pylint disable removed; 5x5. 🌮 (started to type :thumsup:, 🌮 appeared....made a judgement call)

kattni approved these changes

View reviewed changes

Contributor

kattni left a comment

Great job! Thanks for the update!

kattni merged commit a59583f into adafruit:master

tannewt pushed a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request


          Automated update by Adabot (adafruit/adabot@931a805)

b740da5

Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 0.3.0 from 0.2.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#9 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_APDS to 1.1.0 from 1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS#4 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_APDS#3 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_BME280 to 2.0.1 from 2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#6 from sommersoft/new_docs
  > Update README.rst
  > Update README.rst
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#4 from chickadee-tech/lint
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#5 from jerryneedell/patch-1
  > Merge pull request adafruit/Adafruit_CircuitPython_BME280#3 from chickadee-tech/lint

Updating https://github.com/adafruit/Adafruit_CircuitPython_BME680 to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_BME680#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_BMP280 to 3.0.3 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_BMP280#6 from dhalbert/chip_id_error
  > Merge pull request adafruit/Adafruit_CircuitPython_BMP280#5 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO055 to 3.0.2 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO055#7 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_CCS811 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_CCS811#10 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_CharLCD to 2.2.1 from 2.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_CharLCD#7 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground to 1.2.1 from 1.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_CircuitPlayground#29 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DHT to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DHT#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DotStar to 1.1.4 from 1.1.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#13 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#12 from mattytrentini/master
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#11 from mrmcwethy/examples
  > Add RTD.yaml and requirements as cookiecutter would generate them.
  > Merge pull request adafruit/Adafruit_CircuitPython_DotStar#8 from chickadee-tech/master
  > Don't use requirements.txt with RTD
  > Tweak the doc badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_DRV2605 to 0.8.2 from 0.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS1307 to 1.2.1 from 1.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS1307#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS2413 to 1.0.2 from 1.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS2413#5 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_DS2413#4 from brentru/fix-autodoc
  > Merge pull request adafruit/Adafruit_CircuitPython_DS2413#3 from brentru/readthedocs-badge

Updating https://github.com/adafruit/Adafruit_CircuitPython_DS3231 to 2.0.4 from 2.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_DS3231#6 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_DS3231#5 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_Fingerp to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_Fingerp#6 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_FXAS21002C to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_FXAS21002C#4 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700 to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_FXOS8700#6 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_GPS to 3.0.2 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_GPS#3 from cefn/master
  > Merge pull request adafruit/Adafruit_CircuitPython_GPS#2 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 2.0.2 from 2.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#5 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_INA219 to 3.0.2 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_INA219#3 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_INA219#2 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_IRRemote to 3.0.2 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_IRRemote#7 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731 to 2.1.2 from 2.1.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_IS31FL3731#9 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_LIS3DH to 4.0.2 from 4.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_LIS3DH#25 from sommersoft/new_docs

Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM303 to 1.1.0 from 1.0.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM303#3 from kattni/property-name-update

Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX31855 to 3.0.1 from 3.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX31855#5 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX31855#4 from mrmcwethy/examples

Updating https://github.com/adafruit/Adafruit_CircuitPython_MAX7219 to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#10 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_MAX7219#9 from mrmcwethy/addexamples

Updating https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel to 3.2.0 from 3.1.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_NeoPixel#24 from caternuson/master

Updating https://github.com/adafruit/Adafruit_CircuitPython_RFM69 to 1.1.0 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_RFM69#4 from sommersoft/new_docs
  > Merge pull request adafruit/Adafruit_CircuitPython_RFM69#3 from jerryneedell/jerryn_baudrate

Updating https://github.com/adafruit/Adafruit_CircuitPython_SI5351 to 1.0.1 from 1.0.0:
  > Fix enable logic to invert control state.

Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1306 to 2.3.0 from 2.2.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#10 from mrmcwethy/redmerst
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#9 from raidancampbell/feature/expose_functions

Updating https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing to 0.9.0 from 0.8.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_FeatherWing#3 from kattni/joy-featherwing

Updating https://github.com/adafruit/Adafruit_CircuitPython_RTTTL to 2.0.1 from 2.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_RTTTL#3 from brentru/fix-autodoc

Updating https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO to 1.0.2 from 1.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#27 from brentru/fix-autodoc
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#25 from brentru/example-codes
  > Merge pull request adafruit/Adafruit_CircuitPython_SimpleIO#26 from inventhouse/inventhouse-servo-patch-1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet